/*
 * Copyright 2009 Max Kugland
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.splink.deepsplink.page.request {

	/**
	 * An <code>IRequestProcessor</code> is responsible for
	 * executing a request as an asyncronous operation which
	 * results in the change from the current page to the 
	 * requested page. A page is referenced in a request 
	 * through it's id.
	 * 
	 * @author Max Kugland
	 */
	public interface IRequestProcessor {
		
		/**
		 * Changes from the currently displayed page to the page belonging to the given id. 
		 * Uses the current <code>IPageControllerTemplate</code> which implements the algorithm
		 * for changing the page.
		 * 
		 * @param id the id of the page to change to
		 * 
		 * @param pageParams an array of <code>PageParameter</code> instances, enabeling
		 * parameterized pages
		 */
		function gotoPage(id : String, pageParams : Array) : void;
		
		/**
		 * Stops page transitioning and dereferences used resources.
		 */
		function finalize() : void;
	}
}
